home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD 5.bin / workbench / tools / czesc_3 / psx / psx.docs < prev    next >
Text File  |  1991-05-10  |  7KB  |  173 lines
  1.  
  2.  
  3.                   PSX 1.1 (PublicScreenX)
  4.             
  5.                           A 2.0 Public Screen Manager
  6.  
  7.                    by Steve Tibbett
  8.  
  9.  
  10. ---
  11. UPDATE NOTE:  PSX 1.1 is PSX 1.0 with some enforcer hits removed, and
  12. with the addition of a DISPLAYID keyword when starting from CLI.  If
  13. you've got the CBM includes then you can specify a DisplayID as a hex
  14. number as in PSX OPEN Phred DISPLAYID 0x8000 (to get a hires screen).
  15.  
  16. Also, 1.1 changes the way the MAKEDEFAULT keyword works.  MAKEDEFAULT
  17. is now /K instead of /S, meaning it now needs a string.  So to open
  18. Phred and have it be the default, you'd need to do something like
  19. PSX OPEN PHRED MAKEDEFAULT PHRED.
  20. ---
  21.  
  22. PSX is a utility that won't mean much to you unless you have programs that
  23. use public screens, or you need to have a public screen around to open
  24. windows on.
  25.  
  26. PSX can be run with no arguments, in which case it will open up it's
  27. user interface, or you can get it to do most of it's things from the
  28. command line.
  29.  
  30. THE USER INTERFACE
  31.  
  32. The user interface is very straightforward so I will only touch on it
  33. lightly here.  
  34.  
  35. When you run PSX with no arguments, a window will open with gadgets along
  36. the left side, and a scrolling list on the right side.  The scrolling list
  37. contains the names of all the public screens currently in the system, and
  38. the gadgets on the left are various ways of maniuplating items in the list.
  39.  
  40. To select a screen, simply click on it's name.  The name of the last 
  41. selected screen is just below the list.  
  42.  
  43. "Open Screen" will pop up another window with screen selection gadgets -
  44. type in the name you want for your new screen, if you want it to be
  45. hires, etc., click on the appropriate gadgets, then click Open Screen
  46. (or Cancel if you get cold feet).
  47.  
  48. "Close Screen" will attempt to close the screen.  Public Screens are 
  49. supposed to be closed by the program that owns them, so this is usually
  50. only a good idea to perform on screens you have opened with "Open Screen".
  51.  
  52. "Move To Screen" will move the PSX window itself to the selected
  53. screen.  If the screen is LORES, PSX may have a hard time squeezing
  54. itself onto the screen, but otherwise it should have no trouble dealing
  55. with whatever fonts and colours the screen has up.
  56.  
  57. "Make Default" will make the selected screen the "Default Public Screen" -
  58. which simply means that any program smart enough to open on the 
  59. "Default Public Screen" will now open on that ascreen.
  60.  
  61. "Refresh List" just grabs a new copy of the screen list, since it won't
  62. automatically notice if a screen appears or disappears while the
  63. window is open.
  64.  
  65. The next two gadgets are "Global Flags" that affect the operation of all
  66. public screens.  The "Shanghai" flag, when on, will redirect all windows that
  67. would have gone to the "Workbench" screen to the "Default Public Screen",
  68. and the "PopPubScreen" flag will bring to the front any public screen as
  69. a window opens on it.
  70.  
  71. THE COMMAND LINE
  72.  
  73. Typing "PSX ?" will give you this:
  74.  
  75. OPEN/K,CLOSE/K,DISPLAYID/K,HIRES/S,LACE/S,DEPTH/N,MAKEDEFAULT/K,SHANGHAI/S,
  76. NOSHANGHAI/S,POP/S,NOPOP/S,TOFRONT/K,TOBACK/K
  77.  
  78. and in that line is everything you need to know about PSX's command line
  79. interface. The keywords are:
  80.     
  81.     OPEN "ScreenName"
  82.     CLOSE "ScreenName"
  83.     DISPLAYID 0x00000000 (display ID number, 0x#=Hex, otherwise Decimal)
  84.     SHANGHAI
  85.     NOSHANGHAI
  86.     POP
  87.     NOPOP
  88.     TOFRONT "ScreenName"
  89.     TOBACK "ScreenName"
  90.     MAKEDEFAULT "ScreenName"
  91.  
  92. The HIRES and DEPTH items are flags for the OPEN command (ie, 
  93. OPEN "ScreenName" HIRES LACE will open a hires interlaced screen.  The
  94. depth is specified as DEPTH 3 where 3 is the number of bitplanes the
  95. screen is to have.  MAKEDEFAULT specifies that the newly opened screen
  96. should also become the Default Public Screen.
  97.  
  98. SHANGHAI and NOSHANGHAI turn the Shanghai flag on and off.  These get
  99. processed AFTER the "Open" and "Close" commands.
  100.  
  101. POP and NOPOP turn on and off the POPPUBSCREEN flag - enable and disable
  102. the popping to the front of any screen whenever a window is opened.
  103.  
  104. So a valid command line would be:
  105.  
  106.       PSX OPEN "CLIScreen" HIRES LACE DEPTH 1 MAKEDEFAULT "CLIScreen" 
  107.     SHANGHAI POP
  108.  
  109. which would give you a screen entitled "CLIScreen", Hires interlaced,
  110. (with the actual dimensions taken from your preferences), and the SHANGHAI
  111. and POPPUBSCREEN flags are both turned on.
  112.  
  113. This in combination with the fact that under 2.0 you can give a Public
  114. Screen name for console windows to open up on means you can set up a 
  115. screen for the exclusive purpose of running a CLI or two on, making them
  116. one bitplane so they scroll more quickly than the Workbench screen,
  117. which would look kind of ugly in one bitplane.
  118.  
  119. Remember that all public screen names ARE case sensitive - "MyScreen" is 
  120. not the same as "MYSCREEN".
  121.  
  122. THE SOURCE
  123.  
  124. I've included the source to PSX.  It's a very "2.0" program - it uses
  125. the DOS "ReadArgs" call to parse the command line, it uses GadTools for
  126. the user interface, and (I believe) is a good example for dealing with
  127. public screens.
  128.  
  129. It compiles with the Lattice 5.10 C compiler and the 2.0 includes.  It
  130. will probably only compile with Lattice, as I've taken a liking to the 
  131. C++ comment style, which Lattice permits.
  132.  
  133.  
  134. AUTHOR AND DISTRIBUTION INFORMATION
  135.  
  136. PSX is freely redistributable, but is also Copyright 1990 Steve Tibbett.
  137. Distribution is only very slightly limited:  You may not distribute 
  138. PSX without it's current documentation, nor without source, 
  139. and if it is to be commercially distributed, I won't demand but I would
  140. appreciate being sent a copy of whatever it is being distributed with
  141. or on (in the case of disk magazines).
  142.  
  143. Like all my stuff, PSX will likely continue to change.  If you like
  144. PSX, check with wherever you got it every few months for updated
  145. versions, especially if you have problems with it (and have let me
  146. know about them), as I normally fix problems quickly.
  147.  
  148. I don't ask for any cash contribution for PSX.  If you are feeling
  149. guilty and just want to send something, send an original game or
  150. a neat demo, I'll probably appreciate it more than cash.
  151.  
  152.  
  153. My Virutal Addresses:
  154.  
  155.     My BBS is 613-731-3419, up 24 hours/day running my own BBS (BBX)...
  156.     You can reach me on Plink (where I'm an Asst. Chair) as STEVEX...
  157.     You can reach me on Bix as "s.tibbett"...
  158.     You can reach me through FidoNet on point 1:163/109.42...
  159.     You can send me Usenet mail at cognos!alzabo!omx!stevex...
  160.     Or you can call me at 613-731-5316.
  161.  
  162.     I prefer talking with people electronically (including phone) rather
  163.     than mail - I answer all email, but very little paper mail.
  164.  
  165.  
  166. My Physical Address:
  167.  
  168.     Steve Tibbett
  169.     2710 Saratoga Pl. #1108
  170.     Gloucester, Ontario
  171.     K1T 1Z2 Canada
  172.  
  173.